NAVNavbar
Logo
php python csharp java

Get {{up_se_name}} {{up_se_type}} SERP Advanced Results by id

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
	exit();
}
try {
	$result = array();
	// #1 - using this method you can get a list of completed tasks
	// GET /v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready
	// in addition to '{{low_se_name}}' and '{{low_se_type}}' you can also set other search engine and type parameters
	// the full list of possible parameters is available in documentation
	$tasks_ready = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready');
	// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
	if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
		foreach ($tasks_ready['tasks'] as $task) {
			if (isset($task['result'])) {
				foreach ($task['result'] as $task_ready) {
					// #2 - using this method you can get results of each completed task
					// GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/$id
					if (isset($task_ready['endpoint_advanced'])) {
						$result[] = $client->get($task_ready['endpoint_advanced']);
					}
					// #3 - another way to get the task results by id
					// GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/$id
					/*
					if (isset($task_ready['id'])) {
						$result[] = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/' . $task_ready['id']);
					}
					*/
				}
			}
		}
	}
	print_r($result);
	// do something with result
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "3.20191128",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.3059 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11151456-0696-0066-0000-002a5915da37",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0952 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "serp",
        "{{low_se_name}}",
        "{{low_se_type}}",
        "task_get",
        "advanced",
        "11151456-0696-0066-0000-002a5915da37"
      ],
      "data": {
        "api": "serp",
        "function": "task_get",
        "se": "{{low_se_name}}",
        "se_type": "{{low_se_type}}",
        "language_code": "en",
        "location_code": 2840,
        "keyword": "The Museum of Modern Art",
        "priority": "2",
        "tag": "tag1",
        "device": "desktop",
        "os": "windows"
      },
      "result": [
        {
          "keyword": "The Museum of Modern Art",
          "type": "{{low_se_type}}",
          "se_domain": "{{low_se_name}}.com",
          "location_code": 2840,
          "language_code": "en",
          "check_url": "https://google.com/maps/search/The+Museum+of+Modern+Art/@37.09024,-95.712891,4z",
          "datetime": "2019-11-15 12:57:46 +00:00",
          "spell": null,
          "item types": [
            "maps_search"
          ],
          "se_results_count": 85,
          "items_count": 1,
          "items": [
            {
              "type": "maps_search",
              "rank_group": 1,
              "rank_absolute": 1,
              "domain": "moma.org",
              "title": "The Museum of Modern Art",
              "url": "https://www.moma.org/",
              "rating": {
                "rating_type": "Max5",
                "value": 4.6,
                "votes_count": 32718,
                "rating_max": null
              },
              "snippet": "11 W 53rd St, New York, NY 10019",
              "address": "11 W 53rd St, New York, NY 10019",
              "place_id": "Q26C+HX New York",
              "phone": "+12127089400",
              "work_hours": {
                "timetable": {
                  "sunday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  },
                  "monday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  },
                  "tuesday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  },
                  "wednesday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  },
                  "thursday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  },
                  "friday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 21,
                      "minute": 0
                    }
                  },
                  "saturday": {
                    "open": {
                      "hour": 10,
                      "minute": 30
                    },
                    "close": {
                      "hour": 17,
                      "minute": 30
                    }
                  }
                },
                "current_status": "close"
              }
            }
          ]
        }
      ]
    }
  ]
}

Description of the fields for sending a request:

Field name Type Description
id string task identifier
a universally unique identifier (UUID)
unique task identifier in our system
you will be able to use it within 30 days to request the results of the task at any time


‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data array contains the same parameters that you specified in the POST request
        result array array of results
            keyword string keyword received in a POST array
the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            type string search engine type in a POST array
            se_domain string search engine domain in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            check_url string direct URL to search engine results
you can use it to make sure that we provided exact results
Note: to check location-specific results, follow the provided check url, scroll up and down, then click the “Search this area” button
            datetime string date and time when the result was received
in the format “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:
2019-11-15 12:57:46 +00:00
            spell array autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection
                keyword string keyword obtained as a result of search engine autocorrection
the results will be provided for the corrected keyword
                type string type of autocorrection
possible values:
did_you_mean, showing_results_for, no_results_found_for
            item_types array types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
maps_search
            se_results_count integer total number of results in SERP
            items_count integer the number of results returned in the items array
            items array elements of search results found in SERP
            ‘Google Maps’ SERP element
                type string type of element = ‘maps_search’
                rank_group integer group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                rank_absolute integer absolute rank in SERP
absolute position among all the elements in SERP
                domain string domain in the SERP element
                title string title of the result in SERP
                url string relevant URL in SERP
                rating array the element’s rating
the popularity rate based on reviews and displayed in SERP
                    rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                    value integer the value of the rating
                    votes_count integer the amount of feedback
                    rating_max integer the maximum value for a rating_type
                snippet string element snippet
contains the address and other information about the local establishment featured in the element
                address string address line
address of the local establishment featured in the element
                place_id string unique place identifier
plus id of the local establishment featured in the element
                phone string phone number
phone number of the local establishment featured in the element
                work_hours array open hours
information about work hours of the local establishment
                timetable array work hours timetable
                  sunday array work hours on Sundays
                    open array opening time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                    close array closing time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                  monday array work hours on Mondays
                    open array opening time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                    close array closing time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                  tuesday array work hours on Tuesdays
                    open array opening time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                    close array closing time
                      hour integer hours in the 24-hour format
                      minute integer minutes
                  wednesday array work hours on Wednesdays
                    open array opening time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                    close array closing time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                  thursday array work hours on Thursdays
                    open array opening time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                    close array closing time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                  friday array work hours on Fridays
                    open array opening time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                    close array closing time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                  saturday array work hours on Saturday
                    open array opening time
                     hour integer hours in the 24-hour format
                     minute integer minutes
                    close array closing time
                     hour integer hours in the 24-hour format
                     minute integer minutes

‌‌